The Structure class. More...

Public Member Functions
Grammar	getGrammar ()
	Get grammar. More...

	setAlignment (int alignment)
	Set alignment. More...

int	getAlignment ()
	Get alignment. More...

String	getDescription ()
	Get structure description. More...

	setDescription (String description)
	Set structure description. More...

String	getName ()
	Get name. More...

	setName (String name)
	Set name. More...

	setDisabled (BOOL disabled)
	Disable/Enable structure for parsing. More...

	setLength (String length, LENGTH_UNIT lengthUnit)
	Set length of structure. More...

	setRepeatMin (String repeatMin)
	Set minimum repeat count of structure. More...

	setRepeatMax (String repeatMax)
	Set maximum repeat count of structure. More...

int	getElementCount ()
	Get element count. More...

Element	getElementByIndex (int index)
	Get element by index. More...

Element	getElementByName (String name)
	Get element by name. More...

	setDefaultEncoding (String defaultEncoding)
	Set default encoding. More...

String	getDefaultEncoding ()
	Get default encoding. More...

	setElementOrder (ORDER_TYPE order)
	Set element order. More...

int	appendElement (Element *element)
	Append element. More...

void	insertElementAtIndex (Element *element, int index)
	Insert element at certain index. More...

void	deleteElementAtIndex (int index)
	Delete element at index. More...

Detailed Description

The Structure class.

A structure object represents a structure in a grammar.

Author: Andreas Pehnack

Member Function Documentation

◆ appendElement()

int appendElement ( Element * element )

Append element.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in] element The element to be appended

Returns: The index of the appended element

See also: insertElementAtIndex

◆ deleteElementAtIndex()

void deleteElementAtIndex ( int index )

Delete element at index.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in] index The index where to delete

See also: appendElement

◆ getAlignment()

int getAlignment ( )

Get alignment.

The structure is placed at a multiple of the alignment value.

Author: Andreas Pehnack

Date: 2009-10-22

Returns: The alignment value

See also: setAlignent

◆ getDefaultEncoding()

String getDefaultEncoding ( )

Get default encoding.

The default encoding will be used for all strings that don't specify the encoding explicitely.

Author: Andreas Pehnack

Date: 2009-11-07

Returns: The default encoding

See also: getDefaultEncoding

◆ getDescription()

String getDescription ( )

Get structure description.

Author: Andreas Pehnack

Date: 2012-05-12

Returns: The description of the structure

See also: setDescription()

◆ getElementByIndex()

Element getElementByIndex ( int index )

Get element by index.

Author: Andreas Pehnack

Date: 2012-02-05

Returns: The requested structure element

See also: getElementCount; getElementByName

◆ getElementByName()

Element getElementByName ( String name )

Get element by name.

Author: Andreas Pehnack

Date: 2012-02-05

Returns: The requested structure element

See also: getElementByIndex

◆ getElementCount()

int getElementCount ( )

Get element count.

Author: Andreas Pehnack

Date: 2012-02-05

Returns: The number of elements in the structure

See also: getElementByIndex

◆ getGrammar()

Grammar getGrammar ( )

Get grammar.

Returns the grammar this structure is registered in.

Author: Andreas Pehnack

Date: 2014-03-23

Returns: The grammar of this structure

See also: setAlignent

◆ getName()

String getName ( )

Get name.

Get name of structure.

Author: Andreas Pehnack

Date: 2012-05-09

Returns: The name of the structure

See also: setName

Get name of structure.

Author: Andreas Pehnack

Date: 2012-05-09

Returns: The name of the structure

See also: setDisabled

◆ insertElementAtIndex()

void insertElementAtIndex	(	Element *	element,
		int	index
	)

Insert element at certain index.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in]	element	The element to be inserted
[in]	index	The index where to insert

See also: appendElement

◆ setAlignment()

setAlignment ( int alignment )

Set alignment.

The structure is placed at a multiple of the alignment value.

Author: Andreas Pehnack

Date: 2009-10-22

Parameters

[in] alignment The alignment value

See also: getAlignent

◆ setDefaultEncoding()

setDefaultEncoding ( String defaultEncoding )

Set default encoding.

The default encoding will be used for all strings that don't specify the encoding explicitely.

Author: Andreas Pehnack

Date: 2009-11-07

Parameters

[in] defaultEncoding The default encoding

See also: getDefaultEncoding

◆ setDescription()

setDescription ( String description )

Set structure description.

Set description.

Author: Andreas Pehnack

Date: 2012-05-12

Parameters

[in] description The description of the structure

See also: getDescription()

The description is just for documentation purposes.

Author: Andreas Pehnack

Date: 2009-11-07

Parameters

[in] description The default encoding

See also: getDefaultEncoding

◆ setDisabled()

setDisabled ( BOOL disabled )

Disable/Enable structure for parsing.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in] disabled Disable/enable the structure

See also: getDisabled()

◆ setElementOrder()

setElementOrder ( ORDER_TYPE order )

Set element order.

Variable order selects one matching element. Fixed order maps all elements consecutively.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in] order The element order in the structure

See also: getElementOrder

◆ setLength()

setLength	(	String	length,
		LENGTH_UNIT	lengthUnit
	)

Set length of structure.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in]	length	The new length of the structure
[in]	lengthUnit	The new length unit of the structure

See also: getLength

◆ setName()

setName ( String name )

Set name.

Set name of structure.

Author: Andreas Pehnack

Date: 2012-05-09

Parameters

[in] name The new name of the structure

See also: getName

◆ setRepeatMax()

setRepeatMax ( String repeatMax )

Set maximum repeat count of structure.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in] repeatMax The new max repeat count of the structure

See also: setRepeatMin

◆ setRepeatMin()

setRepeatMin ( String repeatMin )

Set minimum repeat count of structure.

Author: Andreas Pehnack

Date: 2013-04-14

Parameters

[in] repeatMin The new min repeat count of the structure

See also: setRepeatMax

The documentation for this class was generated from the following file:

Generated/synalysis_wrap_lua.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ appendElement()

◆ deleteElementAtIndex()

◆ getAlignment()

◆ getDefaultEncoding()

◆ getDescription()

◆ getElementByIndex()

◆ getElementByName()

◆ getElementCount()

◆ getGrammar()

◆ getName()

◆ insertElementAtIndex()

◆ setAlignment()

◆ setDefaultEncoding()

◆ setDescription()

◆ setDisabled()

◆ setElementOrder()

◆ setLength()

◆ setName()

◆ setRepeatMax()

◆ setRepeatMin()